Детальная информация о пользователе

Запрос позволяет получить подробную информацию о пользователе клиента.

Синтаксис запроса

GET https://business.taxi.yandex.ru/api/1.0/client/{идентификатор клиента}/user/{идентификатор пользователя}

🔴 Рекомендуем использовать API 2.0. Поддержка API 1.0 в будущем будет прекращена.

Заголовки запроса:

Authorization

OAuth-токен. Процесс получения токена описан в разделе Начало работы.

Описание полей ответа

В ответе могут содержаться следующие поля:

Поле Описание Формат
phone Телефонный номер пользователя. Строка
role Блок с информацией о роли пользователя. Объект
department_id Идентификационный номер подразделения. Строка
role_id Идентификационный номер роли пользователя. Строка
cost_center Название кост-центра клиента. Строка
cost_centers_id id набора настроек центров затрат (при наличии у клиента новых центров затрат). Необязательное поле. Строка
nickname Краткое имя пользователя. Строка
fullname Полное имя пользователя. Строка
is_active Признак активности пользователя. Неактивный пользователь не имеет возможности самостоятельного заказа и на его имя нельзя заказать поездку. Логическое
_id Идентификационный номер пользователя. Строка
email Адрес электронной почты пользователя. Строка
spent Сумма, потраченная на заказы в данном месяце. Строка

Пример запроса

GET https://business.taxi.yandex.ru/api/1.0/client/a2...d09/user/f65...c57d
...
Authorization: <OAuth-токен>

Пример ответа

Пример ответа на данный запрос выглядит следующим образом:

{
  "phone": "+75551234567",
  "role": {
    "role_id": "1e0202a78f894ad38127aecf31140fbd"
  },
  "department_id": : "233e725b0511459da7b38cb24f2d8fd7", 
  "cost_center": "some cost center"",
  "cost_centers_id": "123...fef",
  "fullname": "Иванов Илья",
  "nickname": "ИИлья",
  "_id": "f65556fd272f459b9ebc67b25756c57d",
  "is_active": true,
  "email": "",
  "spent": 0
}

Возможные коды ответа

Ответ на данный запрос может содержать следующие стандартные HTTP-коды:

  • 200 — запрос выполнен успешно.
  • 401 — был передан неверный OAuth-токен.
  • 403 — у клиента не хватает прав на выполнение данного запроса.
  • 404 — запрашиваемая запись не найдена.
Предыдущая
Создание нового пользователя
Следующая
Удалить пользователя